/*
 * Copyright (c) 2008-2022, Hazelcast, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hazelcast.test;

/**
 * A task that can report the completion progress of some other tested
 * task. Used to write tests that can prolong their execution time in slow
 * environments as long as there is progress.
 *
 * @see HazelcastTestSupport#assertCompletesEventually(ProgressCheckerTask, long)
 * @see TaskProgress
 */
@FunctionalInterface
public interface ProgressCheckerTask {
    /**
     * Collects and returns progress information
     *
     * @return the progress information collected
     */
    TaskProgress checkProgress();
}
